<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>libdill</title>
  <link rel="stylesheet" type="text/css" href="main.css">
</head>
<body>

<h1>libdill: Structured Concurrency for C</h1>

<ul id='toplist'>
<li><a href="index.html">Home</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a href="tutorial.html">Tutorials</a></li>
<li><a href="faq.html">FAQ</a></li>
</ul>
<h1 id="name">NAME</h1>
<p>bundle_wait - wait while coroutines in the bundle finish</p>
<h1 id="synopsis">SYNOPSIS</h1>
<div class="sourceCode"><pre class="sourceCode c"><code class="sourceCode c"><span class="pp">#include </span><span class="im">&lt;libdill.h&gt;</span>

<span class="dt">int</span> bundle_wait(
    <span class="dt">int</span> bndl,
    <span class="dt">int64_t</span> deadline);</code></pre></div>
<h1 id="description">DESCRIPTION</h1>
<p>If there are no coroutines in the bundle the function will succeed immediately. Otherwise, it will wait until all the coroutines in the bundle finish or until deadline is reached.</p>
<p><strong>bndl</strong>: Handle of a coroutine bundle.</p>
<p><strong>deadline</strong>: A point in time when the operation should time out, in milliseconds. Use the <strong>now</strong> function to get your current point in time. 0 means immediate timeout, i.e., perform the operation if possible or return without blocking if not. -1 means no deadline, i.e., the call will block forever if the operation cannot be performed.</p>
<h1 id="return-value">RETURN VALUE</h1>
<p>In case of success the function returns 0. In case of error it returns -1 and sets <strong>errno</strong> to one of the values below.</p>
<h1 id="errors">ERRORS</h1>
<ul>
<li><strong>EBADF</strong>: Invalid handle.</li>
<li><strong>ECANCELED</strong>: Current coroutine was canceled.</li>
<li><strong>ENOTSUP</strong>: The handle does not support this operation.</li>
<li><strong>ETIMEDOUT</strong>: Deadline was reached.</li>
</ul>
<h1 id="example">EXAMPLE</h1>
<div class="sourceCode"><pre class="sourceCode c"><code class="sourceCode c"><span class="dt">int</span> b = bundle();
bundle_go(b, worker());
bundle_go(b, worker());
bundle_go(b, worker());
<span class="co">/* Give wrokers 1 second to finish. */</span>
bundle_wait(b, now() + <span class="dv">1000</span>);
<span class="co">/* Cancel any remaining workers. */</span>
hclose(b);</code></pre></div>
<h1 id="see-also">SEE ALSO</h1>
<p><strong>bundle</strong>(3) <strong>bundle_go</strong>(3) <strong>bundle_go_mem</strong>(3) <strong>bundle_mem</strong>(3) <strong>go</strong>(3) <strong>go_mem</strong>(3) <strong>now</strong>(3) <strong>yield</strong>(3)</p>
</body>
